package com.exam.entity;

/**
 * API结果封装类，用于将API响应的结果以统一的格式返回给客户端
 * 它包含错误码、错误消息和实际返回的数据
 * @param <T> 泛型参数，表示可以封装任意类型的返回数据
 */
public class ApiResult<T> {
    /**
     * 错误码，表示一种错误类型
     * 请求成功，状态码为200
     */
    private int code;

    /**
     * 对错误代码的详细解释
     */
    private String message;

    /**
     * 返回的结果包装在value中，value可以是单个对象
     */
    private T data;

    // 默认构造函数
    public ApiResult() {
    }

    /**
     * 构造函数，用于初始化ApiResult对象
     * @param code 错误码
     * @param message 错误消息
     * @param data 返回的数据
     */
    public ApiResult(int code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    /**
     * 获取错误码
     * @return 错误码
     */
    public int getCode() {
        return code;
    }

    /**
     * 设置错误码
     * @param code 错误码
     */
    public void setCode(int code) {
        this.code = code;
    }

    /**
     * 获取错误消息
     * @return 错误消息
     */
    public String getMessage() {
        return message;
    }

    /**
     * 设置错误消息
     * @param message 错误消息
     */
    public void setMessage(String message) {
        this.message = message;
    }

    /**
     * 获取返回的数据
     * @return 返回的数据
     */
    public T getData() {
        return data;
    }

    /**
     * 设置返回的数据
     * @param data 返回的数据
     */
    public void setData(T data) {
        this.data = data;
    }
}
